Pular para o conteúdo principal

7.2 Consultar centros de custo

Request

Request
query CostCenters {
costCenters(take: 1) {
items {
name
id
creationDate
company {
name
cnpj
companyName
id
}
paymentPlans {
id
}
}
}
}

Params

ParâmetroTipoDescrição
skipIntNúmero de registros a serem pulados no início da coleção. Utilizado para paginação.
takeIntNúmero máximo de registros a serem retornados. Utilizado para paginação.
whereCostCenterFilterInputObjeto que define os critérios de filtragem para os centros de custo.
order[CostCenterSortInput!]Array de objetos que definem a ordem de classificação dos resultados.

Objeto CostCenterFilterInput

CampoTipoDescrição
activeBooleanOperationFilterInputFiltro para o status de ativação
and[CostCenterFilterInput!]Combina filtros usando a lógica AND
changesListFilterInputTypeOfLogHistoryFilterInputFiltro para o histórico de alterações
companyCompanyFilterInputFiltro para os dados da empresa
companyIdIntOperationFilterInputFiltro para o ID da empresa
creationDateDateTimeOperationFilterInputFiltro para a data de criação
deletedBooleanOperationFilterInputFiltro para o status de deleção
externalIdIntOperationFilterInputFiltro para o ID externo
idIntOperationFilterInputFiltro para o ID do objeto da requisição
lastUpdateDateDateTimeOperationFilterInputFiltro para a data da última atualização
nameStringOperationFilterInputFiltro para o nome
or[CostCenterFilterInput!]Combina filtros usando a lógica OR
paymentPlansListFilterInputTypeOfPaymentPlanFilterInputFiltro para os planos de pagamento
refIdUuidOperationFilterInputFiltro para o ID de referência

Objeto CostCenterSortInput

CampoTipoDescrição
activeSortEnumTypeCritério de ordenação para o status de ativação
companyCompanySortInputCritério de ordenação para os dados da empresa
companyIdSortEnumTypeCritério de ordenação para o ID da empresa
creationDateSortEnumTypeCritério de ordenação para a data de criação
deletedSortEnumTypeCritério de ordenação para o status de deleção
externalIdSortEnumTypeCritério de ordenação para o ID externo
idSortEnumTypeCritério de ordenação para o ID do objeto da requisição
lastUpdateDateSortEnumTypeCritério de ordenação para a data da última atualização
nameSortEnumTypeCritério de ordenação para o nome
refIdSortEnumTypeCritério de ordenação para o ID de referência

Response

Response
{
"data": {
"costCenters": {
"items": [
{
"name": "Taxa de Natação",
"id": 26,
"creationDate": "2023-08-29T18:18:34.473Z",
"company": {
"name": "Nova escola teste",
"cnpj": "95.805.290/0001-57",
"companyName": null,
"id": 3
},
"paymentPlans": []
}
]
}
}
}

Result

CampoTipoDescrição
costCentersCostCentersCollectionSegmentColeção de centros de custo

Objeto CostCentersCollectionSegment

CampoTipoDescrição
items[CostCenter!]Lista de objetos do tipo CostCenter
pageInfoCollectionSegmentInfo!Informações para auxiliar na paginação dos resultados.
totalCountInt!Número total de registros encontrados, independentemente da paginação.